/*
 *  PPXMLEntity.h
 *  PigeonsFoundation
 *
 *  Created by Jacob Basham on 2/2/07.
 *  Copyright 2007, PaperPigeons.net
 *  All rights reserved.
 *
 *  Redistribution and use in source and binary forms, with or without 
 *  modification, are permitted provided that the following conditions 
 *  are met:
 *  1. Redistributions of source code must retain the above copyright 
 *     notice, this list of conditions and the following disclaimer.
 *	2. Redistributions in binary form must reproduce the above copyright 
 *	   notice, this list of conditions and the following disclaimer in 
 *	   the documentation and/or other materials provided with the distribution.
 *	3. Neither the name of PaperPigeons.net nor the names of its contributors 
 *	   may be used to endorse or promote products derived from this software 
 *	   without specific prior written permission.
 *
 *  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS 
 *	"AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT 
 *	LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS 
 *	FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE 
 *	COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, 
 *	INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, 
 *	BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; 
 *	LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 
 *	CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 
 *	LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING 
 *	IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
 *	POSSIBILITY OF SUCH DAMAGE.
 */

#import <Foundation/Foundation.h>
#import "PPXMLObject.h"
#import "PPXMLEntityDescription.h"

/*!
    @class
    @abstract    (brief description)
    @discussion  (comprehensive description)
*/
@interface PPXMLEntity : PPXMLObject 
{
	NSString * _textName;
	PPXMLEntityDescription * _description;
}


/*!
    @method     
    @abstract   (brief description)
    @discussion (comprehensive description)
*/
+ (id)XMLEntityWithDescription:(PPXMLEntityDescription *)description 
		parent:(PPXMLEntity *)parent;


/*!
    @method     
    @abstract   (brief description)
    @discussion (comprehensive description)
*/
- (id)initWithDescription:(PPXMLEntityDescription *)description;


/*!
    @method     
    @abstract   (brief description)
    @discussion (comprehensive description)
*/
- (PPXMLEntityDescription *)entityDescription;


/*!
    @method     
    @abstract   (brief description)
    @discussion (comprehensive description)
*/
- (NSXMLElement *)element;


/*!
    @method     
    @abstract   (brief description)
    @discussion (comprehensive description)
*/
- (void)actionFromReader:(PPXMLReader *)reader;


/*!
    @method     
    @abstract   (brief description)
    @discussion (comprehensive description)
*/
- (void)dealloc;

@end
